Contents

Introduction

Generate New Documentation

View Documentation

Print Documentation

Code Librarian

Menu Bar

Tool Bar


Introduction

AutoDoc is an automated documentation generating tool for Microsoft Visual Basic. Documentation on following can be generated selectively by AutoDoc.

Global Data

This  includes a list of Global Variables, Constants, Subroutines and Functions in the project.

Form Details

This includes a list of general procedures and functions, Controls and the associated Event used in the project.

Project Tree

This includes the hierarchical structure of Forms and Modules in the project. The tree can be viewed  as the Code Librarian. The Subroutines and Functions in the Forms or Modules can be extracted selectively for Viewing, Printing  or Filing, so that it can be reused in other projects. Tree can also be used for tracking the procedure calls.

Comment Statistics

This includes the statistical figures like the Number of lines of code, Number of lines of comments, Comment-to-Code ratio, Comment grades. The project statistics includes the Number of Forms, Modules, Number of  Procedures, Functions, Global variables, Constants, Number of API/External function calls, Number of controls.

See Also

Generate New Documentation

View Documentation

Menu Bar


Menu Bar

The AutoDoc Menu Bar provides following menus.

File

Allows to generate new documentation, Open existing documentation, Print the documentation. Set default printer or change paper size and orientation.

View

Allows to view documentation for Global Data, Form Details, Project Tree and Comment Statistics.

Options

Allows to set the Fonts and Comment Grading threshhold value.

Help

Shows Help Contents, Searches topics, Shows help on Getting Started.

See Also

Tool Bar


File Menu

New Document

Opens the New Documentation dialog and allows to generate new documentation.

Open Document

Opens the documentation that was created earlier.

Print Document

Opens the Print Documenatation dialog and allows to print the selected documentation files.

Print Setup

Allows to set default printer, paper sizes and landscape or portrait mode printing.

Exit

Ends the AutoDoc session.

See Also

View Menu

Options Menu


View Menu

Global Data

Allows to view the Global Variables, Constants, Functions and Subroutines in the documented project.

Form Details

Allows to view the Forms and Controls in them with associated Event procedures used and call to other Subroutines or Functions from them.

Project Tree

Allows to view the complete tree of Forms and Modules with Event and General procedures in them for the documented project.

Form/Module Statistics

Allows to view the Form and Module level comment statistics.

Project Statistics

Allows to view the comment statistics of complete project. This view is available only if all items in New Documentation dialog were selected during document generation.

See Also

File Menu

Options Menu


Options Menu

Fonts

Opens a Font selection dialog and allows to set fonts for various items.

Comment Grades

Opens a dialog to set a threshhold percetage value which will be used to decide the grade in Comment-to-Code ratio.

See Also

File Menu

View Menu


Tool Bar

  Generate New Documentation

New Documentation dialog box appears to start document generation.

  Open Documentation

Opens the existing documentation file for the project.

  View Documentation

View Documentation dialog pops up to select the documentation to view.

  Print Documentation

Print Documentation dialog pops up to select the documentation to print.

  AutoDoc Help Contents

Shows Contents of AutoDoc Help

 Exit AutoDoc

Ends your AutoDoc session after confirmation.

See Also

Menu Bar


Project Tree

Project Tree is a hierarchical structure of the project with Forms and Modules. It facilitates the Code Librarian to extract the reusable code in the project.

Viewing Tree

Select Project Tree from View menu. If the Project Tree menu is disabled, documentation for tree is not available. In such case, generate the documentation for the project, with Project Tree option seleted. For viewing the tree, the documentation should be open or should have been just generated.

Printing Tree

Select Print Document from File menu. If the Project Tree option is disabled, documentation for tree is not available. In such case, generate the documentation for the tree. For printing the tree, the documentation should be open or should have been just generated.

See Also

Code Librarian


View Documentation

To view the documentation, it must be open. The title bar of AutoDoc shows the name of the currently open documentation file. If not open, Open Documentation

Select View menu or click View button on the Toolbar.

If you select View menu, you can select any of the following items for views.

Global Data, Form Details, Project Tree, Form/Module Comment Statistics or Project Comment Statistics.

If you click Toolbar button, following view selection dialog appears in which you can select the above view items.

See Also

Code Librarian

Print Documentation

Generate New Documentation

Open Documentation


Print Documentation

To print the documentation, ensure that it is open. The title bar of AutoDoc shows name of the currently open documentation file. If it is not open then open documentation.

Select Print Document from File menu, or click button on the Toolbar. When following dialog appears, select the items to be printed and press OK.

See Also

View Documentation

Generate New Documentation

Code Librarian


New Documentation
Generate New Documentation

To generate documentation for any Visual Basic project, ensure that all files in it have been saved in ASCII text format and proceed with following steps.

From File menu, select New Document or click button on the Toolbar. Following dialog appears on the screen.

In the Project File, type Visual Basic  project file name. Browse can be used to select the project file.

In the Document Directory, type the directory where you wish to keep the project documentation. If the specified directory does not exist, it will be created.

Select the items in Generate Document For to generate corresponding documentation.

Set the documentation header information using Set Info.

Press Generate button to start the documentation process.

See Also

View Documentation

Print Documentation

Open Documentation


Open Documentation

To open the documentation for the project, select Open Document from File menu or click button on the Toolbar. When dialog appears, select the AutoDoc file.

Note:

To view or print any previously created documentation, it must be opened first. The title bar of AutoDoc shows name of the open AutoDoc file. If the document is just generated then it is already open.

See Also

View Documentation

Print Documentation

Generate New Documentation

Code Librarian


Code Librarian

AutoDoc allows to extract the reusable code from previous projects with the help of Code Librarian which is built in project tree view window. To invoke Code Librarian, select Project Tree in View menu options. Following window appears on the screen.

To View, Print, File the code, select the code and drag it on corresponding buttons with Right mouse button or press the button.

See Also

View Documentation


Fonts

Fonts for printing can be set by selecting Fonts from Options menu. Set Fonts and their sizes when following dialog appears.


Comment Grades

The threshold percentage value for deciding the comment grades in the documentation is set by selecting Comment Grades from Options menu when following dialog appears.


Print Setup

Print Setup allows to select printer, papersize and orientation. Select Print Setup form File menu for following dialog.

See Also

Print Documentation